home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / cmds / man.man < prev    next >
Encoding:
Text File  |  1991-09-04  |  4.5 KB  |  97 lines
  1. ' $Header: /sprite/src/cmds/man/RCS/man.man,v 1.6 91/01/08 21:48:08 tve Exp $ SPRITE (Berkeley)
  2. .so \*(]ltmac.sprite
  3. .HS MAN cmds
  4. .BS
  5. .SH NAME
  6. man \- Print entries in the user reference manual
  7. .SH SYNOPSIS
  8. \fBman\fR [\fIoptions\fR] [\fIsectionNumber\fR] \fIentryName entryName ...\fR
  9. .SH OPTIONS
  10. .IP "\fB\-a\fR" 15
  11. Search all man directories.  By default, directories marked "ALL" in the
  12. configure file will be skipped.  In Sprite, the \fB\-a\fR flag will cause
  13. Software Warehouse directories to be searched.
  14. .IP "\fB\-c \fIconfigFile\fR" 15
  15. \fBMan\fR normally looks in the file \fB/sprite/lib/man/config\fR for
  16. information about where the man pages are.  If the \fB\-c\fR switch is given,
  17. then \fBman\fR uses \fIconfigFile\fR instead.
  18. .IP "\fB\-i\fR" 15
  19. Generate index.  Instead of printing manual entries, treat each
  20. \fIentryName\fR as a file name.  Read all the files, and output index
  21. information on standard output.
  22. .IP "\fB\-help\fR" 15
  23. Print a summary of the command-line options and exit without printing
  24. any manual pages.
  25. .IP "\fB\-k\fR" 15
  26. Keyword search.  Instead of printing manual entries, treat each \fIentryName\fR
  27. argument as a keyword, search the manual indexes for information about
  28. the keywords, and print all the matching index entries.
  29. .IP "\fB\-r\fR" 15
  30. Normally, \fBman\fR retains formatted versions of man pages for faster printing.
  31. It only reformats a man page if there is no formatted version or if the
  32. source is newer than the formatted version.  This switch causes \fBman\fR to
  33. reformat the man page even if the formatted copy appears to be up-to-date.
  34. .IP "\fB\-s \fIsectionName\fR" 15
  35. Check only in section \fIsectionName\fR of the manual for the desired
  36. entries.
  37. .IP "\fB\-t\fR" 15
  38. Print the manual entries on the printer instead of on
  39. standard output.
  40. .IP "\fB\-\fR" 15
  41. \fBMan\fR normally filters the man pages through \fBmore -s\fR to break up
  42. the output and process underline and boldface requests.  If the \fB\-\fR
  43. switch is given, then the \fBmore\fR filter is omitted, and the \fBnroff\fR
  44. output is passed directly to standard output. The \fBPAGER\fP environment
  45. variable can be set to the name of a program to use instead of \fBmore\fP.
  46. .BE
  47.  
  48. .SH DESCRIPTION
  49. .PP
  50. The \fBman\fR program locates and prints one or more entries of the
  51. Sprite reference manual.  The entries are given by the \fIentryName\fR
  52. arguments;  these are usually the names of programs or library
  53. procedures.  Normally, \fBman\fR searches the entire manual and invokes
  54. \fBmore\fR to print the
  55. first entry that matches each \fIentryName\fR.  The manual is divided
  56. into sections, and it is possible for the same name to be used for
  57. entries in different sections.  You may use the
  58. \fB\-s\fR switch to specify a particular section;  in this case, \fBman\fR
  59. will look only in the named section.  Section names include both the
  60. traditional UNIX names (\fB1\fR, \fB2\fR, etc.) and the Sprite names
  61. (\fBcmds\fR, \fBlib\fR, \fBlib/c\fR, \fBdev\fR, etc.).
  62. You may specify a section name without the \fB\-s\fR switch
  63. if the section name starts with a number and is entered as the first
  64. \fIentryName\fR.
  65. .PP
  66. The default configuration file causes the current directory to be
  67. searched for the desired manual entry before the system directories.
  68. If there is a file \fIentryName\fB.man\fR in the current directory,
  69. then it will be printed in preference to any entries in the system
  70. area.
  71. .PP
  72. The \fB\-i\fR switch causes \fBman\fR to generate an index
  73. instead of printing a manual page.  Each \fIentryName\fR argument
  74. is taken to be a file name.  \fBMan\fR will read all the files and
  75. output index information for them on standard output.  Normally, each
  76. directory containing installed unformatted manual entries also has
  77. a file named \fBindex\fR containing index information for all the files
  78. in the directory.  When printing manual entries, if \fBman\fR cannot
  79. locate a file for a given \fIentryName\fR, then it reads the \fBindex\fR
  80. files to see if \fIentryName\fR is an alternate name for some other
  81. manual entry (an alternate name is any name listed in the \fBNAME\fR
  82. section of the entry).
  83. .PP
  84. The \fB\-k\fR switch causes \fBman\fR to perform a keyword search instead
  85. of printing a manual page.  Each \fIentryName\fR argument is taken to
  86. be a keyword, and \fBman\fR searches all the \fBindex\fR files for
  87. entries that match the keywords.
  88. Each matching entry is printed on standard output in a human-readable form.
  89. A keyword matches an index entry if
  90. it is a substring of any of the entry's name, synopsis, or keyword fields.
  91.  
  92. .SH FILES
  93. /sprite/lib/man/config \- default configuration file
  94.  
  95. .SH KEYWORDS
  96. help, index, keyword, manual, reference, section
  97.